# tap.closeSocket(Object object)

推荐使用 SocketTask 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控,同时存在多个 webSocket 的链接的情况下使用 tap 前缀的方法可能会带来一些和预期不一致的情况。

以 Promise 风格调用:支持

相关文档: 网络使用说明、局域网通信

# 功能描述

关闭 WebSocket 连接。

# 参数

# Object object

属性类型默认值必填说明
codenumber1000(表示正常关闭连接)一个数字值表示关闭连接的状态号,表示连接被关闭的原因。
reasonstring一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

# 示例代码

tap.connectSocket({
  url: 'test.php'
})

//注意这里有时序问题,
//如果 tap.connectSocket 还没回调 tap.onSocketOpen,而先调用 tap.closeSocket,那么就做不到关闭 WebSocket 的目的。
//必须在 WebSocket 打开期间调用 tap.closeSocket 才能关闭。
tap.onSocketOpen(function() {
  tap.closeSocket()
})

tap.onSocketClose(function(res) {
  console.log('WebSocket 已关闭!')
})